chore: update mrd doc with special cases and optimize cloudbuild.yaml #1689
Conversation
product-auto-label
bot
added
size: xs
Summary of ChangesHello @chandra-siri, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on two distinct areas: optimizing the Cloud Build configuration for system tests and enhancing documentation for an experimental asynchronous multi-range downloader. The Cloud Build changes streamline SSH key management, while the documentation updates provide clearer guidance on specific parameter usage, improving overall clarity and efficiency. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request aims to optimize a Cloud Build configuration and update documentation. However, the Cloud Build change introduces a critical issue by specifying an incorrect path for an SSH key file, which will cause the key cleanup step to fail silently. Additionally, the documentation update for async_multi_range_downloader.py includes an unclear and likely erroneous entry that needs correction for clarity.
| echo "--- Removing SSH key from OS Login profile to prevent accumulation ---" | ||
| gcloud compute os-login ssh-keys remove \ | ||
| --key-file=/workspace/gcb_ssh_key.pub || true | ||
| --key-file=/.ssh/google_compute_engine.pub || true |
There was a problem hiding this comment.
The path to the public key file appears to be incorrect. The key is generated at /workspace/.ssh/google_compute_engine.pub, but this step attempts to access it from /.ssh/google_compute_engine.pub. Since /workspace is persisted across build steps, the correct absolute path should be used. The || true will prevent the build from failing, but the SSH key will not be removed from the OS Login profile, leading to an accumulation of keys over time, which this step is intended to prevent.
--key-file=/workspace/.ssh/google_compute_engine.pub || true| Special meaning for `start_byte` and `bytes_to_read` | ||
| (0, 0) : Downloads entire file | ||
| () |
There was a problem hiding this comment.
The documentation for special meanings of start_byte and bytes_to_read seems incomplete or contains a typo. The line with just () is unclear and could be confusing to users. Please clarify what this represents or remove it if it's an error.
1 participant
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
Fixes #<issue_number_goes_here> 🦕